/*
 * The MIT License
 * Copyright (c) 2011 kc4.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.kc4.sso.filter;

import java.io.Serializable;

/**
 * SSO プロバイダーの認証インターフェースを提供します。
 *
 * @author yoichi kikuchi
 * @since 1.0.0
 */
public interface Authenticator {

	/**
	 * 認証範囲、ユーザー名、パスワードを使用して認証を行います。
	 * 認証範囲には、ドメイン名や、会社コードなどが含まれます。
	 * 認証に失敗した場合は、null を返却します。
	 *
	 * @param realm 認証範囲。
	 * @param username ユーザー名。
	 * @param password パスワード。
	 * @return 認証結果。認証失敗時は、null。
	 */
	public Serializable auth(String realm, String username, String password);
}
